Resource OperationDefinition/FHIR Server from package hl7.at.fhir.tc.wg.scheduling.r5#current (16 ms)

Resources that use this resource

No resources found

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

Source

{
  "resourceType" : "OperationDefinition",
  "id" : "appointment-book",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition appointment-book</b></p><a name=\"appointment-book\"> </a><a name=\"hcappointment-book\"> </a><a name=\"appointment-book-en-US\"> </a><p>URL: [base]/Appointment/$book</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>appointment-resource</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R5/resource.html\">Resource</a> (<a href=\"StructureDefinition-at-scheduling-appointment.html\" title=\"http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/at-scheduling-appointment\">HL7® AT Scheduling Appointment Profile</a>)</td><td/><td><div><p>The full appointment resource is needed for this operation. The appointment SHALL have the status <code>proposed</code>.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R5/parameters.html\">Parameters</a></td><td/><td><div><p>The response will be a Parameters resource consisting of the requested Appointment resource and an OperationOutcome with errors, warnings or information as a result of processing the operation. The Appointment resource will have an updated <code>status</code> of <code>booked</code> if the request is approved, <code>pending</code> if it needs to be manually confirmed or  <code>cancelled</code> if it is rejected.</p>\n</div></td></tr></table></div>"
  },
  "url" : "http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/OperationDefinition/appointment-book",
  "version" : "0.2.0",
  "name" : "Book_Appointment_Operation",
  "status" : "active",
  "kind" : "operation",
  "date" : "2025-05-23T10:55:12+00:00",
  "publisher" : "HL7® Austria, TC FHIR®",
  "description" : "Request to book a selected Appointment. This operation follows the appointment availability and optional hold interactions. This operation completes the booking of an appointment. The server determines if the nominated appointment is still available (i.e., all the required actors and physical assets needed for the appointment are still available) and either accepts or rejects the book request and updates the resource status accordingly. ",
  "affectsState" : true,
  "code" : "book",
  "resource" : [
    "Appointment"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "appointment-resource",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The full appointment resource is needed for this operation. The appointment SHALL have the status ```proposed```.",
      "type" : "Resource",
      "targetProfile" : [
        "http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/at-scheduling-appointment"
      ]
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The response will be a Parameters resource consisting of the requested Appointment resource and an OperationOutcome with errors, warnings or information as a result of processing the operation. The Appointment resource will have an updated `status` of ```booked``` if the request is approved, ```pending``` if it needs to be manually confirmed or  ```cancelled``` if it is rejected.",
      "type" : "Parameters"
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.